MarkLogic 9 Product Documentation
GET /manage/v2/databases/{id|name}?view=counts

Summary

This resource address returns the count information for forests attached to the named database. The database can be identified either by id or name.

URL Parameters
format	The format of the returned data. Can be either `html`, `json`, or `xml` (default). This value overrides the Accept header if both are present.

Request Headers
Accept	The expected MIME type of the response. If the `format` parameter is present, it takes precedence over the Accept header.

Response Headers
Content-type	The MIME type of the data in the response body. Depending upon the value of the `format` parameter or Accept header, one of `application/xml`, `application/json`, or `text/html`.

Response

Upon success, MarkLogic Server returns status code 200 (OK), and the response body contains the requested data. If the URI is malformed or the database does not exist, a status code of 400 (Bad Request) is returned. A status code of 401 (Unauthorized) is returned if the user does not have the necessary privileges.

Required Privileges

This operation requires one of the following:

the manage-user role
the following privilege:
http://marklogic.com/xdmp/privileges/manage
the manage role plus one of the following granular privileges:
- http://marklogic.com/xdmp/privileges/admin/database/database-ID
- http://marklogic.com/xdmp/privileges/admin/database/activity/database-ID
where activity is one of the following:
- backup
- merge
- restore
- clear
- index

Usage Notes

The count information includes the document count, directory count, active fragment count, deleted fragment count, and nascent fragment count.

The structure of the output returned from this REST API is as follows:

id

name

meta

Properties of the view rather than the resource.

This is a complex structure with the following children:

uri

The path to the view.

current-time

The timestamp for when the view was generated.

elapsed-time

The time required to construct the view. The elapsed time indicates the relative cost of generating the view. Consider the cost when determining how frequently to request a view.

start-min

The timestamp for filtering out more recent requests or transactions.

view-error

An error limiting the data in the view.

This is a complex structure with the following children:

error-type: The kind of error.
error-name: The name of the error.
error-code: The error identifier.
error-message: The error text.

count-properties

The statistics about the database.

This is a complex structure with the following children:

documents: The number of documents in the database.
directories: The number of directories in the database.
active-fragments: The number of fragments in active use in the database.
deleted-fragments: The number of fragments marked for deletion in the database.
nascent-fragments: The number of nascent fragments in the database.

related-views

A list of broader or narrower views on the resource or resource type.

This is a complex structure with the following children:

related-view

A broader or narrower view on the resource or resource type.

This is a complex structure with the following children:

view-type: The kind of view.
view-name: The name of the view.
view-uri: The path for the view.

Example


http://localhost:8002/manage/v2/databases/Documents?view=counts

==> Returns counts information on the forests attached to the 
    Documents database.

MarkLogic 9 Product DocumentationGET /manage/v2/databases/{id|name}?view=counts

Summary

Response

Required Privileges

Usage Notes

Example

MarkLogic 9 Product Documentation
GET /manage/v2/databases/{id|name}?view=counts